/**

This file is part of MaCI/GIMnet.

MaCI/GIMnet is free software: you can redistribute it and/or modify it 
under the terms of the GNU Lesser General Public License as published 
by the Free Software Foundation, either version 3 of the License, or 
(at your option) any later version.

MaCI/GIMnet is distributed in the hope that it will be useful, but WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public 
License for more details.

You should have received a copy of the GNU Lesser General Public 
License along with GIMnet. (See COPYING.LESSER) If not, see 
<http://www.gnu.org/licenses/>.

**/
/**
 * $Id: description.hpp,v 1.4 2009-05-13 07:18:19 amaula Exp $
 *
 * \file
 * \brief Definition for common datatype 'Description'
 * \author Antti Maula <antti.maula@tkk.fi>
 */
#ifndef _MACI_COMMON_DESCRIPTION_HPP_
#define _MACI_COMMON_DESCRIPTION_HPP_

namespace MaCI {
  namespace Common {

    /** Description.
     *
     * This structure defines a datatype for 
     * pointing to a description. The
     * "pointed" string must be NULL terminated.
     * The structure itself doesn't contain information
     * about the length of the description, so a
     * higher level container is required 
     * (Like class gim::binbag::CBinBag)
     */
    struct TDescription
    { 
      char description[]; ///< Freeform description of arbitrary length.
    };
  }
}
#endif // _MACI_COMMON_DESCRIPTION_HPP_
